home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / mfile300.zip / MFILE.DOC < prev    next >
Text File  |  1991-10-29  |  17KB  |  345 lines
  1.                               MagnaFile v2.00
  2.                      The Ultimate File List Compiler
  3.                      for Telegard 2.5i, 2.5j, & 2.5k
  4.  
  5.                  Copyright (C) 1990,1991 by Blue Wave Software
  6.                            All Rights Reserved
  7.  
  8.                                 Written by
  9.                               George Hatchew
  10.                                    and
  11.                                Fred Rappuhn
  12.  
  13.  
  14.   We would like to thank Martin Pollard for supplying us with the
  15.   information needed to complete this project.
  16.  
  17.   Blue Wave Software would like to thank you for showing interest in
  18.   MagnaFile;  the ultimate in file list compiler programs for Telegard
  19.   2.5i+.
  20.  
  21.   When this program was started, it was simply meant to be a NEW file list
  22.   compiler, which would allow SysOps running The Blue Wave Mail Door to
  23.   pass along a file listing showing all new files uploaded to his/her BBS
  24.   since the user's last mail download.  This would then be displayed inside
  25.   The Blue Wave Mail Reader when the user begins reading his/her mail
  26.   packet.
  27.  
  28.   Well, it developed into a monster!  As we went along, we kept thinking of
  29.   all the 'neat' things that could be done with it.  So, features kept
  30.   being added.  And added.  It is now to the point where we are satisfied
  31.   it can do everything we can think of.  If it doesn't do something *you*
  32.   want it to do, let us know!  There's always room for growth.
  33.  
  34.   If you are not running The Blue Wave Mail Door, or do not know what The
  35.   Blue Wave Mail System is, here is a little information:
  36.  
  37.   The Blue Wave Mail Door is the first Off-Line Reader/Mail System for
  38.   Telegard BBS systems.  You, as a Sysop, run the Blue Wave Mail Door as
  39.   an external utility, allowing your users to capture mail (FidoNet, Local
  40.   Bases, GroupMail) into a compressed format.  The user then downloads the
  41.   mail packet, and has the opportunity to read the messages OFF-LINE, at
  42.   their convenience.  This in turn, frees up your BBS so you can get more
  43.   callers on in one day.  It also makes your users more active in the
  44.   message bases.  Since this documentation is for MagnaFile, we won't go
  45.   into detail about all of the features of The Blue Wave Mail System.  We
  46.   can only suggest that you give it a try.  If you cannot find a copy, you
  47.   can file request the system from either:
  48.  
  49.   1:2240/107 -- The Flight of the Raven   9600bps  HST-Dual Standard
  50.   1:2240/176 -- The Wild! Blue BBS        2400bps  MNP-5.
  51.  
  52.   The latest version of the door (BBS portion) can be FREQed as BWTG,
  53.   and the latest version of the reader (User portion) can be FREQed as
  54.   BWREADER.  You will need both files for the complete package.
  55.  
  56.  
  57.  
  58.                                 MagnaFile
  59.                                 ---------
  60.  
  61.   MagnaFile, in it's simplest form, will simply generate a list of new
  62.   files since a user's last call date to your system.  This list can then
  63.   be passed to The Blue Wave Mail Reader, where it will be shown to the
  64.   users when they read their mail packet.
  65.  
  66.   MagnaFile has 9 command line switches, and 2 command line parameters,
  67.   which can be combined in many, many different ways to achieve the
  68.   desired output.  As always, the cryptic command line syntax reads:
  69.   (parameters in [] are completely optional)
  70.  
  71.   MGNAFILE outputfile [headerfile] [switches]
  72.  
  73.   OutputFile:  The file list that MagnaFile will create.  This can be a
  74.                complete drive:\path\filename.ext, or simply a file name.
  75.                If you do not specify a path, the file will be written in
  76.                the current directory.
  77.  
  78.   HeaderFile:  File to include at the TOP of the listing.  This can be
  79.                something like a BBS advertisement, ANSI picture, or system
  80.                information.  The contents of [headerfile] will not be
  81.                altered, but will be copied into [outputfile].
  82.  
  83.   Switches  :  There are 8 valid command line switches--
  84.  
  85.               /ALL        Default=OFF (builds only new file list)
  86.               /INFO       Default=OFF (does not append user info to list)
  87.               /ANSI       Default=OFF (does not use ANSI color in file list)
  88.               /ONELINE    Default=OFF (compiles 2-line-per-file listing)
  89.               /NOPAUSE    Default=ON  (will insert {PAUSE}'s for the reader)
  90.               /MASTER     Default=OFF (when on, will build COMPLETE list)
  91.               /NOSTATS    Default=ON  (will append file area stats at end)
  92.               /ACS=xxx    Default=OFF (when used will build custom lists)
  93.               /DAYS=nnn   Default=OFF (when used will specify #of days to check)
  94.               /NOLIST=xxx Default=OFF (when used will NOT build lists for
  95.                                        those with ACS of xxx.)
  96.  
  97.                The operations of these switches will be discussed in the
  98.                next section.  In most cases, you can use them together to
  99.                create your custom file list.
  100.  
  101.  
  102.                      MagnaFile Command Line Switches
  103.                      -------------------------------
  104.  
  105.   MagnaFiles command line switches may confuse some people.  You may or
  106.   may not ever use them, but you are missing out on a great deal of power
  107.   if you don't.  Full descriptions and examples will be given to help you
  108.   keep your hair [it may be grey when you are done, but at least you still
  109.   have it!].
  110.  
  111.   To pass a file to The Blue Wave Reader, you must first specify a file
  112.   name to send using BWUTILS.EXE.  In the G)eneral Information menu, there
  113.   are 5 fields, labeled READER FILES.  For ease in discussion, lets use
  114.   NEWFILES.TXT.  Insert NEWFILES.TXT into one of the empty fields.
  115.  
  116.   Now you will want to edit your BLUEWAVE.BAT file to run MGNAFILE before
  117.   each user enters the door:
  118.  
  119.   cd\bbs\bluewave
  120.   mgnafile newfiles.txt
  121.   bwmail
  122.   cd\bbs
  123.   exit
  124.  
  125.   When running MGNAFILE with no switches, it will look for BWMAIL.CTL in
  126.   the current directory.  If it is found, it will read it's information
  127.   from there, and then look for DOOR.SYS in your Telegard Directory [or
  128.   wherever you told BWMAIL to find DOOR.SYS].  It will find out
  129.   information about the current user on-line, and build a text file of any
  130.   new files that were uploaded since the user last called your BBS.
  131.  
  132.   To make a colorful new-file listing, use the command:
  133.  
  134.   MGNAFILE newfiles.txt /ansi
  135.  
  136.   in your batch file.  To include a system advertisement at the beginning
  137.   of the file, use the command:
  138.  
  139.   MGNAFILE newfiles.txt header.txt /ansi
  140.  
  141.   in the batch file.
  142.  
  143.   That was the basic purpose of this program.  However, the following
  144.   command line parameters were added to make your list more 'customized'.
  145.  
  146.   /ALL       **>  You can use the /ALL command to generate a file listing
  147.                   of ALL files on your system that the current user in
  148.                   DOOR.SYS has access to.  By using the /ACS= command, you
  149.                   can eliminate the need for DOOR.SYS.  When you use the
  150.                   /ALL command, /DAYS= is not valid, since the purpose of
  151.                   /ALL is to list all accessable files, regardless of age.
  152.  
  153.   /ANSI      **>  This command line switch is valid when used with any
  154.                   other switch.  It simply adds ANSI color to the file
  155.                   listing. [A nice touch to the bland display if you are
  156.                   including a file list with your mail packets.]
  157.  
  158.   /INFO      **>  This switch is valid *only* when a DOOR.SYS file is used
  159.                   to base the file listing on.  It will append user's
  160.                   information into the file listing indicating:
  161.  
  162.                     1)  Number of file points user has.
  163.                     2)  Number of files a user has downloaded.
  164.                     3)  Number of K the user has downloaded.
  165.                     4)  Your system's upload/download ratio by Kilobytes.
  166.                     5)  Your system's upload/download ratio by # of files.
  167.  
  168.                   /INFO is invalid when used in conjunction with /MASTER
  169.                   and the /ACS=xxx command.
  170.  
  171.   /ONELINE   **>  MagnaFile defaults to a 2-line-per-file listing of any
  172.                   files contained in the file listing.  2-line mode
  173.                   displays:
  174.  
  175.                      1)  File Name.
  176.                      2)  File Size, in bytes.
  177.                      3)  File Points required to download the file.
  178.                      4)  Number of times the file has been downloaded.
  179.                      5)  If file is offline, it indicates OFFLINE.
  180.                      6)  File Description.
  181.                      7)  File's extended description, if any.
  182.  
  183.                    By using the /ONELINE command, you can force MagnaFile
  184.                    into a 1-line-per-file listing.  This 1-line mode
  185.                    displays:
  186.  
  187.                      1)  File Name.
  188.                      2)  File Size, in bytes.
  189.                      3)  File Description.
  190.                      4)  File's extended description, if any.
  191.  
  192.   /NOPAUSE   **>  Forces MagnaFile *not* to insert the {PAUSE} strings
  193.                   that The Blue Wave Off-line Mail Reader needs in order
  194.                   to pause the ANSI 'reader file' screens.  This switch is
  195.                   not needed when compiling a list with the /MASTER
  196.                   option.  When using /MASTER, /NOPAUSE is automatically
  197.                   set to ON.
  198.  
  199.   /MASTER    **>  Forces MagnaFile to compile a COMPLETE list of files on
  200.                   your BBS.  DOOR.SYS is not required, and any [read: all]
  201.                   ACS strings are ignored.  This is handy for a sysop to
  202.                   compile a complete listing of files for his/her own
  203.                   reference.  /MASTER overrides the /ACS=xxx, /DAYS=nnn,
  204.                   and /ALL commands.  In other words, if /MASTER is used,
  205.                   the only valid commands are /ANSI, /ONELINE, and
  206.                   /NOSTATS.
  207.  
  208.                   [{PAUSE} strings are automatically turned OFF, as
  209.                   described above].
  210.  
  211.   /NOSTATS   **>  When compiling either a /ALL, /ACS=, or /MASTER file
  212.                   listing, MagnaFile will add file area statistics to the
  213.                   end of your file listing, indicating the number of files
  214.                   in each area, the number of bytes used by those files,
  215.                   and grand totals of the number of bytes used, and number
  216.                   of files in your file listing.  Using /NOSTATS will
  217.                   cause MagnaFile *not* to append this statistics listing.
  218.  
  219.   /ACS=xxx   **>  By using the /ACS=xxx command, you may override the need
  220.                   for a DOOR.SYS file.  Much of the power of MagnaFile
  221.                   lies in this command, and its companion, /DAYS=nnn.  It
  222.                   is much easier to explain this command by using
  223.                   examples:
  224.  
  225.                   You want to compile a file listing for all users who
  226.                   have access to file areas with the following
  227.                   restrictions:
  228.  
  229.                   Must have security of 30.
  230.                   Must be 18 years old.
  231.                   Must have a flag of X (you want to include those adult
  232.                   files :->).
  233.  
  234.                   By using the command:
  235.                   MGNAFILE c:\bbs\dls\files.lst /ACS=s30a18fx
  236.                   you can compile a file listing of ONLY the file areas
  237.                   that a user with those parameters would have access to.
  238.  
  239.                   Please note that the above example will compile a list
  240.                   of ALL files accessible by a user with those parameters.
  241.                   In other words, /ALL is automatically activated.
  242.  
  243.                   The only valid ACS codes for compiling a file listing
  244.                   are:
  245.  
  246.                   Snnn  -=>  Users with a security level of nnn.
  247.                   Dnnn  -=>  Users with a download security level of nnn.
  248.                   Pnnn  -=>  Users with nnn file points.
  249.                   Ann   -=>  Users must be at least nn years old.
  250.                   Fx    -=>  Users must have the flag x. (A-Z are valid)
  251.                   Unnnn -=>  User must be user # nnnn in USER.LST.
  252.                   Bnnn  -=>  User must be at nnn baud (3=300, 12=1200,
  253.                              192=19200).
  254.  
  255.  
  256.                   Please note that 'vv' WILL NOT WORK, although it is
  257.                   possible to accomplish the same thing.  If your
  258.                   validated users have s50, fv, and must be 12 years old,
  259.                   then simply use '/ACS=s50fva12' as the command.
  260.                   However, if MagnaFile encounters a 'vv' for the security
  261.                   level of a file area, and you are compiling a NEW files
  262.                   listing, the 'vv' WILL work (MagnaFile pulls the 'vv'
  263.                   ACS string out of the setup for BWUTILS).
  264.  
  265.   /DAYS=nnn  **>  Finally, the /DAYS=nnn command.  /DAYS=nnn is valid
  266.                   *only* when used with the /ACS=xxx command.  As stated
  267.                   above, /ACS=xxx defaults to compiling a listing of *all*
  268.                   files for the specified ACS level.  By using the
  269.                   /DAYS=nnn option, you can specify the number of days to
  270.                   include in the file listing.
  271.  
  272.                   To list all new files within the last 10 days for users
  273.                   with a security level of 50, use the following:
  274.  
  275.                   MGNAFILE 10days.lst /ACS=s50 /DAYS=10 /ANSI
  276.  
  277.  
  278.   /NOLIST=xxx     By special request comes the /NOLIST=xxx command.  If you
  279.                   use the /NOLIST switch, you will be able to NOT generate
  280.                   a new files list for those with an ACS specified by xxx.
  281.                   This is useful for Long Distance callers who may not want
  282.                   to get your NEW FILES listing each time they enter The Blue
  283.                   Wave Mail Door.  If the user online (DETERMINED BY DOOR.SYS)
  284.                   fits into the ACS specified, a file will not be produced!
  285.  
  286.  
  287.   There are so many possible ways to use MagnaFile, we must leave it up to
  288.   you to be creative.  We were successful in setting up a File Area menu
  289.   letter that would essentially do the following:
  290.  
  291.   1)  Create a DOOR.SYS file.
  292.   2)  Run a batch file containing all of the commands needed to:
  293.          A)  Execute MagnaFile with the proper parameters.
  294.          B)  Place the compiled file listing in a specified download area.
  295.          C)  Compress the File listing.
  296.          D)  Return to Telegard.
  297.          E)  Display a file telling the user where he may download the
  298.              newly compiled file listing.
  299.   3)  After Telegard exited back to the mailer after each caller, it is
  300.       necessary to add a check to your batch file similar to the
  301.       following:
  302.  
  303.       if exist c:\bbs\dls\uploads\newfiles.lst delete newfiles.lst
  304.  
  305.  
  306.   In our batch file, we used the MagnaFile command line:
  307.   MGNAFILE newfiles.lst /ALL /NOPAUSE /INFO
  308.  
  309.   This command line generates a CUSTOM file listing for the user currently
  310.   online!  Now there is no more need to worry that your users are seeing
  311.   files in your FILES listing that they don't have access to!  It also
  312.   informs them of their upload/download standings (/INFO) and will
  313.   instruct MagnaFile not to insert the {PAUSE} strings (/NOPAUSE).
  314.  
  315.   Again, be creative!
  316.  
  317.  
  318.   MagnaFile is distributed as FREEWARE.  There is no charge to use this
  319.   program.  If you use it, and enjoy it, please pass it along to a friend!
  320.  
  321.   Questions/comments/suggestions/complaints about MagnaFile and/or The
  322.   Blue Wave Mail System should be directed to the following nodes:
  323.  
  324.                     1:2240/176  Sysop: George Hatchew
  325.                     1:2240/107  Sysop: Fred Rappuhn
  326.  
  327.   There is a national support echo on the FidoNet backbone called BLUEWAVE.
  328.   Here we will be able to answer any and all questions related to products
  329.   produced by Blue Wave Software.
  330.  
  331.   We monitor the National FidoNet TELEGARD echo every day, however, I am
  332.   sure Martin would like to keep the subject to TELEGARD.  We can answer
  333.   questions there also, but please respect the echo conference rules and
  334.   try not to wander off-topic [too much].
  335.  
  336.   Thank you for your support.
  337.  
  338.   ---George Hatchew
  339.   ---Fred Rappuhn
  340.  
  341.   Blue Wave Software
  342.   PO Box 1057
  343.   Flint, MI  48503
  344.  
  345.